Skip to main content

chat

Chat Model​

Defines the structure of a chat session, including its configuration, metadata, and system status.

id (integer, ReadOnly)​

Unique identifier for the chat. Automatically generated by the system.

title (string) Required​

Title or name of the chat session. Must be at least 1 character.

assistant (integer) Required​

ID of the assistant associated with this chat. Used to determine assistant behavior and response generation.

messages (array[Message], ReadOnly)​

Visible messages exchanged in the chat. Read-only and maintained internally by the system.

metadata (object, ReadOnly)​

Chat-level metadata as key-value pairs. Values are stored as strings.

max_responses (integer, ReadOnly)​

Maximum number of assistant responses allowed per user message. This is a fixed configuration for the session.

max_msg_length (integer, ReadOnly)​

Maximum length allowed for each message in characters or tokens. Set based on assistant configuration.

comment (string, Optional)​

Optional user-provided comment or note on the chat. Can be null.

like (boolean, Optional)​

Indicates whether the user liked the chat session. Can be true, false, or null.

created_at (string, date-time, ReadOnly)​

Timestamp of when the chat was created. Formatted in ISO 8601.

updated_at (string, date-time, ReadOnly)​

Timestamp of the last update to the chat. Useful for tracking activity or modifications.

matrix_mode (boolean) Required​

Indicates whether matrix reasoning mode was enabled during the chat.

execution_status (string) Required​

Current status of the assistant's execution for the chat. Can reflect values such as:

  • "AVAILABLE"
  • "RUNNING"
  • "ERROR"
  • "ENDED"
  • "ENDED_MAX_INTERACTIONS"
  • "FORCED_ENDED"
  • "WAITING_FOR_AUTH"

tools (array[object], ReadOnly)​

Tools associated with this chat. Each item includes id, name, and description.

Example​

{
  "id": 0,
  "title": "string",
  "assistant": 0,
  "messages": [],
  "metadata": {
    "channel": "web"
  },
  "max_responses": 10,
  "max_msg_length": 570,
  "comment": "string",
  "like": true,
  "created_at": "2025-05-28T21:16:32.399Z",
  "updated_at": "2025-05-28T21:16:32.399Z",
  "matrix_mode": true,
  "execution_status": "AVAILABLE",
  "tools": [
    {
      "id": 1,
      "name": "search_docs",
      "description": "Search documents"
    }
  ]
}